Instalación de las Notificaciones Webhook

Requisitos​

Es necesario que dispongan de un servidor que pueda recibir notificaciones de menta tech. Este servidor debe estar disponible en internet y debe contar con un certificado SSL válido.

Además, requerimos que el servidor cuente con un endpoint que pueda recibir peticiones HTTP POST.

Configuración​

Para configurar las notificaciones Webhook, deben proporcionarnos la URL del endpoint que recibirá las notificaciones. Para ello, deben comunicarse con el equipo de menta tech a través del canal directo de contacto que les fue asignado.

Ejemplo

POST https://yourplatform.com/webhooks/mentatickets

ATENCIÓN

Recomendamos que la URL de acceso no sea enumable, es decir, que no sea posible acceder a ella mediante un navegador web. Esto es para evitar que se pueda acceder a la URL de forma accidental o maliciosamente. Además, para mejorar la seguridad, pueden implementar un mecanismo de autenticación en el endpoint detallado más adelante.

Una vez que se haya configurado el endpoint, menta tech comenzará a enviar notificaciones a este endpoint cada vez que sea necesario (ej., si se activa a desactiva un producto desde el dashboard de menta, si se produce un cambio en el estado de un ticket, etc.).

Formato de las notificaciones​

Las notificaciones Webhook se envían en formato JSON. El siguiente ejemplo muestra la estructura de una notificación:

{
 "family": "ticket",
 "action": "ticket.updated",
 "data": {
   "id": "00001", // El ID que usa tu plataforma para identificar la entidad.
   "newOwnerEmail": "new_owner@email.com"
 }
}

Todas las notificaciones tendrán al menos la estructura compuesta por los siguientes campos: family, action y data.

Campo family

Hace referencia al tipo de entidad que se modifica. Más adelante se explicarán los tipos de entidades que se pueden modificar.

Campo action

Refiere al tipo de acción que se realizó sobre la entidad. Está compuesto por el nombre de la entidad y el tipo de acción.

Campo data

Contiene la información relevante que se debe actualizar de la entidad. Por cuestiones técnicas sólamente enviamos información relevante de la actualización.

Política de Reintentos​ Todas las notificaciones se reintentarán indefinidamente hasta que recibamos un código de respuesta satisfactorio de su servidor.

Códigos de respuesta satisfactorios:

200 OK, 201 CREATED, 202 ACCEPTED, 204 NO CONTENT

Los reintentos se realizarán con un intervalo de tiempo que va aumentando progresivamente. Este intervalo de tiempo entre reintento y reintento va desde 5 segundos hasta los 8 minutos. Si luego de 50 reintentos, el mensaje no logra ser entregado, el mismo dejará de ser reintentado y entrará en estado de envío no prioritario.

Este envío no prioritario va a continuar reintentando enviar el mensaje, pero con un intervalo de tiempo mucho mayor, que parte de las 12hs hasta las 24hs.

Atención

Es importante que se aseguren de que los mensajes lleguen bien a su servidor, sobre todo en la etapa de pruebas. En caso que su servidor no esté disponible durante un largo periodo de tiempo, puede provocar que los mensajes se acumulen en nuestro sistema y que se produzcan retrasos en la entrega de los mismos, derivando en inconsistencia de datos.